// 版权所有2012 Go作者。保留所有权利。
// 此源代码的使用受BSD样式
// 许可证的约束，该许可证可以在许可证文件中找到。

package doc

import (
	"strings"
	"unicode"
)

// firstSentenceLen返回s中第一个句子的长度。
// 句子在第一个句点后结束，后面跟空格，
// 前面没有一个大写字母。
// 
func firstSentenceLen(s string) int {
	var ppp, pp, p rune
	for i, q := range s {
		if q == '\n' || q == '\r' || q == '\t' {
			q = ' '
		}
		if q == ' ' && p == '.' && (!unicode.IsUpper(pp) || unicode.IsUpper(ppp)) {
			return i
		}
		if p == '。' || p == '．' {
			return i
		}
		ppp, pp, p = pp, p, q
	}
	return len(s)
}

const (
	keepNL = 1 << iota
)

// clean将每个空格、\n、\r或\t字符序列
// 替换为一个空格，并删除所有尾随空格和前导空格。
// 如果设置了keepNL标志，换行符将通过
// 传递，而不是更改为空格。
func clean(s string, flags int) string {
	var b []byte
	p := byte(' ')
	for i := 0; i < len(s); i++ {
		q := s[i]
		if (flags&keepNL) == 0 && q == '\n' || q == '\r' || q == '\t' {
			q = ' '
		}
		if q != ' ' || p != ' ' {
			b = append(b, q)
			p = q
		}
	}
	// 删除尾随空格，如果有任何
	if n := len(b); n > 0 && p == ' ' {
		b = b[0 : n-1]
	}
	return string(b)
}

// 大纲返回s中第一个句子的清理版本。
// 该句子在第一个句点后加空格结束，且
// 前面不加一个大写字母。结果字符串
// 没有\n、\r或\t字符，并且在
// 单词之间只使用单个空格。如果s以任何非法前缀开头，则结果
// 为空字符串。
// 
func Synopsis(s string) string {
	s = clean(s[0:firstSentenceLen(s)], 0)
	for _, prefix := range IllegalPrefixes {
		if strings.HasPrefix(strings.ToLower(s), prefix) {
			return ""
		}
	}
	s = convertQuotes(s)
	return s
}

var IllegalPrefixes = []string{
	"copyright",
	"all rights",
	"author",
}
